Make public-API modules public; add CLA notice#24
Merged
Conversation
pdoc skips module-level docstrings from private submodules when symbols are re-exported via __init__.py. Compose __doc__ dynamically from the existing submodule docstrings so pdoc renders the exception hierarchy, extension examples, gate parameter conventions, and usage examples that were previously invisible in the generated documentation.
splch
changed the title
Update the package_init template to compose __doc__ dynamically from submodule docstrings instead of using a static literal. This way pdoc renders the exception hierarchy, extension examples, gate parameter conventions, and usage examples that were previously invisible.
Rename _exceptions, _extensions, _gates, _pagination, _polling, and _session to drop the underscore prefix. These modules all export user-facing symbols and were only private by convention. Making them public lets pdoc render their module-level docstrings naturally, eliminating the dynamic __doc__ composition workaround entirely. _transport.py stays private as it contains only internal plumbing.
splch
changed the title
guenp
reviewed
Apr 26, 2026
|
|
||
| ## Contributor License Agreement | ||
|
|
||
| To receive IonQ's CLA, please contact @mjk or email [opensource@ionq.com](mailto:opensource@ionq.com). |
guenp
approved these changes
Apr 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
_exceptions,_extensions,_gates,_pagination,_polling,_session) to public by dropping the_prefix. These all export user-facing symbols; making them public lets pdoc render their module-level docstrings (exception hierarchy, extension examples, gate parameter conventions, usage examples) naturally without any workarounds._transport.pystays private as it contains only internal plumbing.Test Plan
uv run pytest tests/- 219 passed, 100% coverageuv run ruff format --check && ruff check- cleanuv run pdoc -o docs/ -d google ionq_core- module docstrings now render on submodule pagesCloses #20